package com.zentrale1.noodlemail.classifiers;

import java.util.Arrays;

import com.zentrale1.noodlemail.Mail;

/*
 * The MIT License
 * 
 * Copyright (c) 2010 Andreas Fleig
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */


public abstract class NoodleClassifier 
{
	protected String[] folderNames;
	
	public NoodleClassifier(String[] folderNames)
	{
		this.folderNames = folderNames;
	}
	
	
	/**
	 * Trains the classifier. Implemented by concrete class.
	 * @param mail
	 * @param category
	 */
	protected abstract void _train(Mail mail, String category);

	
	/**
	 * Classifies a mail. Implemented by concrete class.
	 * @param mail
	 * @return
	 */
	protected abstract Result[] _classify(Mail mail);
	
	
	/**
	 * Get the name of the classifier
	 * @return Name of the classifier
	 */
	public abstract String getName();
	
	
	/**
	 * Trains the classifier
	 * @param mail
	 * @param category
	 */
	public void train(Mail mail, String category)
	{
		_train(mail, category);
	}
	
	
	/**
	 * Classifies a mail
	 * @param mail
	 * @return Array of Results (category-confidence pairs), ordered by confidence
	 */
	public Result[] classify(Mail mail)
	{
		Result[] categories = _classify(mail);
		Arrays.sort(categories);
		
		return categories;
	}

}